com.inscoper.nbo.ImagingEnvironment

Represents the XML element ImagingEnvironment. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	ImagingEnvironment()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString() Serializes this object to an XML string.
void	setID(EnvironmentalControlDeviceID_Type value) Sets the value of the ID attribute.
EnvironmentalControlDeviceID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setTemperature(String value) Sets the value of the Temperature attribute.
String	getTemperature() Returns the value of the Temperature attribute.
void	setTemperatureUnit(UnitsTemperature_Type value) Sets the value of the TemperatureUnit attribute.
UnitsTemperature_Type	getTemperatureUnit() Returns the value of the TemperatureUnit attribute.
void	resetTemperatureUnit() Resets the TemperatureUnit attribute to an unset state.
boolean	hasTemperatureUnit() Checks whether the optional TemperatureUnit attribute is present.
void	setCO2Percent(String value) Sets the value of the CO2Percent attribute.
String	getCO2Percent() Returns the value of the CO2Percent attribute.
void	setHumidity(String value) Sets the value of the Humidity attribute.
String	getHumidity() Returns the value of the Humidity attribute.
void	setAirPressure(float value) Sets the value of the AirPressure attribute.
float	getAirPressure() Returns the value of the AirPressure attribute.
void	resetAirPressure() Resets the AirPressure attribute to an unset state.
boolean	hasAirPressure() Checks whether the optional AirPressure attribute is present.
void	setAirPressureUnit(UnitsPressure_Type value) Sets the value of the AirPressureUnit attribute.
UnitsPressure_Type	getAirPressureUnit() Returns the value of the AirPressureUnit attribute.
void	resetAirPressureUnit() Resets the AirPressureUnit attribute to an unset state.
boolean	hasAirPressureUnit() Checks whether the optional AirPressureUnit attribute is present.
void	setO2Percent(PercentFraction_Type value) Sets the value of the O2Percent attribute.
PercentFraction_Type	getO2Percent() Returns the value of the O2Percent attribute.
void	resetO2Percent() Resets the O2Percent attribute to an unset state.
boolean	hasO2Percent() Checks whether the optional O2Percent attribute is present.
void	setDescription(Description value) Sets the value of the Description element.
Description	getDescription() Returns the value of the Description element.
void	resetDescription() Resets the Description element to an unset state.
boolean	hasDescription() Checks whether the optional Description element is present.
void	setMap(Map_Type value) Sets the value of the Map element.
Map_Type	getMap() Returns the value of the Map element.
void	resetMap() Resets the Map element to an unset state.
boolean	hasMap() Checks whether the optional Map element is present.
ImagingEnvironment	__internal_create(long cPtr, boolean own)

Protected Functions

	Name
	ImagingEnvironment(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(ImagingEnvironment obj)

Additional inherited members

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.ImagingEnvironment;

Represents the XML element ImagingEnvironment.

This element describes the environment in which the biological sample was maintained during the Acquisition of this Image.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function ImagingEnvironment

public ImagingEnvironment()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID

public void setID(
    EnvironmentalControlDeviceID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

This is the Unique Identifier of the Environmental Control Device used in this case.

function getID

public EnvironmentalControlDeviceID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

This is the Unique Identifier of the Environmental Control Device used in this case.

function resetID

public void resetID()

Resets the ID attribute to an unset state.

This is the Unique Identifier of the Environmental Control Device used in this case.

function hasID

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

This is the Unique Identifier of the Environmental Control Device used in this case.

function setTemperature

public void setTemperature(
    String value
)

Sets the value of the Temperature attribute.

Parameters:

value The value to set

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function getTemperature

public String getTemperature()

Returns the value of the Temperature attribute.

Return: The value of the attribute

The field records the Temperature at which this Image Acquisition was performed. Allowed values include a number or the phrase "Room Temperature".

function setTemperatureUnit

public void setTemperatureUnit(
    UnitsTemperature_Type value
)

Sets the value of the TemperatureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTemperatureUnit

public UnitsTemperature_Type getTemperatureUnit()

Returns the value of the TemperatureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTemperatureUnit

public void resetTemperatureUnit()

Resets the TemperatureUnit attribute to an unset state.

No description available in the XSD standard.

function hasTemperatureUnit

public boolean hasTemperatureUnit()

Checks whether the optional TemperatureUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setCO2Percent

public void setCO2Percent(
    String value
)

Sets the value of the CO2Percent attribute.

Parameters:

value The value to set

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function getCO2Percent

public String getCO2Percent()

Returns the value of the CO2Percent attribute.

Return: The value of the attribute

The field records the Carbon Dioxide concentration (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Conditions".

function setHumidity

public void setHumidity(
    String value
)

Sets the value of the Humidity attribute.

Parameters:

value The value to set

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function getHumidity

public String getHumidity()

Returns the value of the Humidity attribute.

Return: The value of the attribute

The field records the Humidity (expressed as a % value) at which this Image Acquisition was performed. Allowed values include a number or the phrase "Ambient Humidity".

function setAirPressure

public void setAirPressure(
    float value
)

Sets the value of the AirPressure attribute.

Parameters:

value The value to set

The field records the AirPressure the Acquisition of this Image was performed at.

function getAirPressure

public float getAirPressure()

Returns the value of the AirPressure attribute.

Return: The value of the attribute

The field records the AirPressure the Acquisition of this Image was performed at.

function resetAirPressure

public void resetAirPressure()

Resets the AirPressure attribute to an unset state.

The field records the AirPressure the Acquisition of this Image was performed at.

function hasAirPressure

public boolean hasAirPressure()

Checks whether the optional AirPressure attribute is present.

Return: true if the optional attribute has been set, false otherwise

The field records the AirPressure the Acquisition of this Image was performed at.

function setAirPressureUnit

public void setAirPressureUnit(
    UnitsPressure_Type value
)

Sets the value of the AirPressureUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getAirPressureUnit

public UnitsPressure_Type getAirPressureUnit()

Returns the value of the AirPressureUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetAirPressureUnit

public void resetAirPressureUnit()

Resets the AirPressureUnit attribute to an unset state.

No description available in the XSD standard.

function hasAirPressureUnit

public boolean hasAirPressureUnit()

Checks whether the optional AirPressureUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setO2Percent

public void setO2Percent(
    PercentFraction_Type value
)

Sets the value of the O2Percent attribute.

Parameters:

value The value to set

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function getO2Percent

public PercentFraction_Type getO2Percent()

Returns the value of the O2Percent attribute.

Return: The value of the attribute

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function resetO2Percent

public void resetO2Percent()

Resets the O2Percent attribute to an unset state.

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function hasO2Percent

public boolean hasO2Percent()

Checks whether the optional O2Percent attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field records the Oxygen concentration around the sample [units:none] during the Acquisition of this Image. Expressed as a percentage fraction as a value from 0.0 to 1.0.

function setDescription

public void setDescription(
    Description value
)

Sets the value of the Description element.

Parameters:

value The value to set

No description available in the XSD standard.

function getDescription

public Description getDescription()

Returns the value of the Description element.

Return: The value of the element

No description available in the XSD standard.

function resetDescription

public void resetDescription()

Resets the Description element to an unset state.

No description available in the XSD standard.

function hasDescription

public boolean hasDescription()

Checks whether the optional Description element is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setMap

public void setMap(
    Map_Type value
)

Sets the value of the Map element.

Parameters:

value The value to set

This is a Mapping of Key/Value pairs.

function getMap

public Map_Type getMap()

Returns the value of the Map element.

Return: The value of the element

This is a Mapping of Key/Value pairs.

function resetMap

public void resetMap()

Resets the Map element to an unset state.

This is a Mapping of Key/Value pairs.

function hasMap

public boolean hasMap()

Checks whether the optional Map element is present.

Return: true if the optional attribute has been set, false otherwise

This is a Mapping of Key/Value pairs.

function __internal_create

public static ImagingEnvironment __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

Protected Functions Documentation

function ImagingEnvironment

protected ImagingEnvironment(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr

protected static long getCPtr(
    ImagingEnvironment obj
)

Updated on 2026-02-13 at 16:10:58 +0100